 /*******************************************************************************
  * Copyright (c) 2006, 2007 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  * IBM Corporation - initial API and implementation
  * Brad Reynolds - bug 164134
  *******************************************************************************/
 package org.eclipse.core.databinding.validation;

 import org.eclipse.core.databinding.util.Policy;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.Status;

 /**
  * Convenience class for creating status objects.
  *
  * @since 3.3
  *
  */
 public class ValidationStatus extends Status {

     /**
      * Creates a new validation status with the given severity, message, and
      * exception.
      *
      * @param severity
      * @param message
      * @param exception
      */
     private ValidationStatus(int severity, String message, Throwable exception) {
         super(severity, Policy.JFACE_DATABINDING, IStatus.OK, message, exception);
     }

     /**
      * Creates a new validation status with the given severity and message.
      *
      * @param severity
      * @param message
      */
     private ValidationStatus(int severity, String message) {
         super(severity, Policy.JFACE_DATABINDING,IStatus.OK, message, null);
     }

     /**
      * Creates a new validation error status with the given message.
      *
      * @param message
      * @return a new error status with the given message
      */
     public static IStatus error(String message) {
         return new ValidationStatus(IStatus.ERROR, message);
     }

     /**
      * Creates a new validation cancel status with the given message.
      *
      * @param message
      * @return a new cancel status with the given message
      */
     public static IStatus cancel(String message) {
         return new ValidationStatus(IStatus.CANCEL, message);
     }
     
     /**
      * Creates a new validation error status with the given message and
      * exception.
      *
      * @param message
      * @param exception
      * @return a new error status with the given message and exception
      */
     public static IStatus error(String message, Throwable exception) {
         return new ValidationStatus(IStatus.ERROR, message, exception);
     }

     /**
      * Creates a new validation warning status with the given message.
      *
      * @param message
      * @return a new warning status with the given message
      */
     public static IStatus warning(String message) {
         return new ValidationStatus(IStatus.WARNING, message);
     }
     
     /**
      * Creates a new validation info status with the given message.
      *
      * @param message
      * @return a new info status with the given message
      */
     public static IStatus info(String message) {
         return new ValidationStatus(IStatus.INFO, message);
     }
     
     /**
      * Returns an OK status.
      *
      * @return an ok status
      */
     public static IStatus ok() {
         return Status.OK_STATUS;
     }

     /*
      * (non-Javadoc)
      *
      * @see java.lang.Object#hashCode()
      */
     public int hashCode() {
         final int prime = 31;
         int result = 1;

         String message = getMessage();
         int severity = getSeverity();
         Throwable throwable = getException();

         result = prime * result + ((message == null) ? 0 : message.hashCode());
         result = prime * result + severity;
         result = prime * result
                 + ((throwable == null) ? 0 : throwable.hashCode());
         return result;
     }

     /**
      * Equality is based upon instance equality rather than identity.
      *
      * @see java.lang.Object#equals(java.lang.Object)
      */
     public boolean equals(Object obj) {
         if (this == obj)
             return true;
         if (obj == null)
             return false;
         if (getClass() != obj.getClass())
             return false;
         final ValidationStatus other = (ValidationStatus) obj;

         if (getSeverity() != other.getSeverity())
             return false;
         if (getMessage() == null) {
             if (other.getMessage() != null)
                 return false;
         } else if (!getMessage().equals(other.getMessage()))
             return false;
         if (getException() == null) {
             if (other.getException() != null)
                 return false;
         } else if (!getException().equals(other.getException()))
             return false;
         return true;
     }
 }

